home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / betsy22.zip / BETSY.DOC < prev    next >
Text File  |  1992-06-07  |  21KB  |  461 lines

  1.  
  2.                           BETSY ROSS Solitaire
  3.  
  4.                                   v2.2
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    BETSY ROSS is a fast-paced card solitaire game in which you remove cards
  21.    from a grid in a pre-defined sequence. Very hard to beat!
  22.  
  23.  
  24.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  25.          created in the directory you run the door from.
  26.  
  27.  
  28.  
  29.                               INSTALLATION
  30.                               ____________
  31.  
  32.  
  33.    Installation is fairly easy and straight-forward. The following steps and
  34.    examples should have you up and running in a very short period of time.
  35.    It is assumed that you are familiar with setting up DOORS on your system.
  36.    To this end, only examples of the configuration file and Door batch file
  37.    are described.
  38.  
  39.       1) Create a directory to hold all BETSY files
  40.  
  41.       2) Unzip BETSYxx.ZIP into the the above directory
  42.  
  43.          NOTE: BRUN45.EXE is not included but is required !!!
  44.  
  45.       3) Create a configuration file, with a name of your choice, or
  46.          modify the supplied BETSY.CFG file. A description follows:
  47.  
  48.             **                       Location of system file (See Below)
  49.             SUNRISE-80 BBS           Your BBS Name
  50.             Al                       Sysop's First nameAP
  51.  
  52.             Lawrence                 Sysop's Last Name
  53.  
  54. |-----------------------------------------------------------------------------|
  55. | READ!     1                        CommPort  \ These 2 lines are required   |
  56. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  57. |-----------------------------------------------------------------------------|
  58.  
  59.             00000000                 Registration Number
  60.  
  61.     !   #   2                        Maximum # of Games per day
  62.                                      (Sysop gets 99, Registered version ONLY)
  63.  
  64.         #   0                        Max # of days a caller can make up, during
  65.                                      calls in one day. 0=Disable Make-up Option
  66.                                      Maximum value = 27, Minimum value = 1
  67.  
  68.         #   NONE                     Drive:\Path\Filename to contain the
  69.                                      Top Score Bulletin or enter NONE
  70.                                      for NO Bulletin creation.
  71.  
  72.         #   NONE                     Drive:\Path\Filename to contain the
  73.                                      Top Score Bulletin (Color) or enter NONE
  74.                                      for NO Bulletin creation.
  75.  
  76.         #   NONE                     Drive:\Path\Filename to contain the
  77.                                      Hall of Fame Bulletin or enter NONE
  78.                                      for NO Bulletin creation.
  79.  
  80.         #   NONE                     Drive:\Path\Filename to contain the
  81.                                      Hall of Fame Bulletin (Color) or enter NONE
  82.                                      for NO Bulletin creation.
  83.  
  84.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  85.                                      2 = Display ADOPT-A-DOOR message
  86.  
  87.         #   2                        Keyboard timeout value in Minutes
  88.  
  89.     !   #   0                        Time allowed in Door
  90.                                      (Sysop = Time Remaining - REG. VERSION)
  91.  
  92.         #   N                        Automatic game reset at end of month:
  93.                                        Y = Yes enable autoreset
  94.                                        N = Keep accumulating scores
  95.  
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  98.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  99.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  100.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  101.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  102.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  103.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  106.     @   #   XXXX/YYYY                 Blackout Range  From/To
  107.     @   #   XXXX/YYYY                 Blackout Range  From/To
  108.     @   #   XXXX/YYYY                 Blackout Range  From/To
  109.     @   #   XXXX/YYYY                 Blackout Range  From/To
  110.     @   #   XXXX/YYYY                 Blackout Range  From/To
  111.  
  112.  
  113.      
  114.               ** = Replace with ONE of the following:
  115.  
  116. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  117. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  118. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  119.                                    (Note:DOOR.SYS must be in SAME directory)
  120. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  121. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  122. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  123. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  124. C:\BBS\GTUSER.BBS               <- For GT Power 
  125.                                    * if using this option you must put the
  126.                                      ComPort # on line 5 and the Node # on
  127.                                      line 6 of the configuration file
  128.  
  129.  
  130.  
  131.            # = Requires registration to change to a different value.
  132.            ! = See "Plays Per Day" Below
  133.            @ = See "Blackout Periods" Below
  134.  
  135.                NOTE: There are NO Blank Lines in the Config File!!
  136.  
  137.  
  138.  
  139.  
  140.       4) Create a batch file or modify the BETSY file supplied. A
  141.          description of this file follows:
  142.  
  143.             ECHO off
  144.             cd\BBS\DOORS\BETSY        Location of BETSY files
  145.             BETSY  BETSY.CNF          EXE filename and CNF filename (Name
  146.                                       used in creating file in #3 above)
  147.             CD\BBS
  148.             BOARD
  149.  
  150.  
  151.        5) When running in more than one node, be sure to supply a
  152.           different configuration name for each node (your choice of name).
  153.  
  154.  
  155.   
  156.          
  157.                MAKE-UP DAYS (Registered version only)
  158.                --------------------------------------
  159.  
  160. The Make-Up-Day feature allows the caller to make up any plays he/she missed 
  161. during the current month and prior to the current call. You control whether 
  162. to allow this option, as well as the number of days the caller can make up, on
  163. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  164. configuration file, turns the option OFF, any other value (up to a max of 27)
  165. turns the option ON and dictates the number of days the caller can make up.
  166.  
  167.  
  168. NOTE:      The number of games per day is calculated as follows...
  169.  
  170.            Games Allowed per day x Number of makeup days.
  171.  
  172. Example:   Games Allowed per day = 2
  173.            Max # of makeup days  = 4
  174.  
  175. If a caller logs in on 5/8/92 and this is their first call of the month, they
  176. would have a potential of 16 games to makeup and bring them current 
  177. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  178. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8 
  179. (games allowed * max # of makeup days).
  180.  
  181.  
  182.  
  183.              HALL OF FAME BULLETINS (Registered version only)
  184.              ------------------------------------------------
  185.  
  186. The program will automatically reset the game when the first caller of the
  187. month plays the game. The score file will be cleared and a set of Hall of Fame
  188. bulletin files will be created. The files will be called SUNHOF.ASC and 
  189. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same 
  190. directory as the BETSY.EXE file. You are responsible for COPYING the files to 
  191. your bulletin area and renaming to a filename of your choice.
  192.  
  193. WARNING: The HOF files are cumulative files. That means they are read in each 
  194.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  195.          the record of prior months winners!!!!
  196.   
  197.  
  198.  
  199.                           BLACKOUT PERIODS
  200.                           ________________
  201.  
  202.       Use the Blackout ranges option to define up to 5 time periods during
  203.       which you DO NOT want the Door to be played. If a caller tries to access 
  204.       the Door during the Blackout period, they will be shown a message that
  205.       contains ALL the Blackout periods you have defined, and to try the Door
  206.       at a later time.
  207.  
  208.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  209.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  210.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  211.  
  212.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  213.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  214.                    a Blackout range.
  215.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  216.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  217.  
  218.  
  219.  
  220.                           PLAYS Per DAY/DOOR Time
  221.                           _______________________
  222.  
  223.       Plays Per Day and Door Time can be controlled several ways:
  224.  
  225.       (1) You can use the Games Per Day, singular option, in the config
  226.           file above. This option, will affect ALL callers whose Security
  227.           Level is NOT defined in any of the 10 optional Security Level/
  228.           Plays Per Day entries in the config file.
  229.  
  230.       (2) You can use the Door Time, singular option, in the config file
  231.           above. This option, will affect ALL callers whose Security
  232.           Level is NOT defined in any of the 10 optional Security Level/
  233.           Plays Per Day/Door Time entries in the config file.
  234.  
  235.       (3) You can restrict the number of games a specific Security Level
  236.           will be allowed to play per day or REWARD specific Levels with 
  237.           more Plays Per Day. 
  238.  
  239.           Likewise, you can restrict the Play time for a specific Security
  240.           Level or REWARD specific Levels with more Door Time.
  241.  
  242.           These options are handled by the use of the 10 config 
  243.           entries (000=00/00). 
  244.           
  245.           The format of each entry is as follows:
  246.  
  247.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  248.                      where =  is a constant and MUST be included
  249.                      where YY is the # of games per day (must be 2 digits)
  250.                      where / is a constant and MUST be included
  251.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  252.           
  253.           If the callers Security Level is NOT defined, his/her Plays Per
  254.           Day and Door Time will be controlled by the values in items
  255.           (1) and (2), above, respectively..
  256.  
  257.           You may define up to 10 Security Levels. All unused entries must
  258.           be defined as   000=00/00
  259.         --------------------------------------------------------------------
  260.           Example: Suppose you had 3 Security Levels defined on your BBS as
  261.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  262.           wanted to set Plays Per Day as :     Subscriber=5
  263.                                            Visiting Sysop=2
  264.                                                   CoSysop=3
  265.                                                    Friend=10 
  266.           
  267.           and Door Time as follows:     Subscriber=30 minutes
  268.                                     Visiting Sysop=20 minutes
  269.                                            CoSysop=10 minutes 
  270.                                             Friend=remaining call time
  271.                                
  272.  
  273.           You would set the Individual "Games per Day" config entry to 1 and 
  274.           the individual "Door Time" to 5 minutes (these would be the 
  275.           default number of games and default Time for all Security Levels
  276.           other than 20,30 or 40... make them any number you want). Next you
  277.           would replace 4 of the Security Level entries as :  020=05/30                                               
  278.                                                               030=02/20
  279.                                                               040=03/10
  280.                                                               090=10/0
  281.  
  282.  
  283.                         NON-STANDARD COM SUPPORT
  284.                         ________________________
  285.  
  286.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  287.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  288.       number after the configuration filename. Let's assume your Door is
  289.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  290.       passed to your Door would be:
  291.  
  292.                             FOOBAR FOOBAR.CFG /5
  293.  
  294.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  295.       normally used with COM1. No /x parameter is needed for the standard
  296.       IRQ's.
  297.  
  298.       As an alternative, you may use an environmental variable on the command
  299.       line. To use the variable (following the example above), place a 
  300.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  301.       different IRQ number for each node). The command line would now look 
  302.       like this: 
  303.  
  304.                           FOOBAR FOOBAR.CFG /%IRQ%
  305.       
  306.       This, in combination with the use of the environmental variables 
  307.       described in the MULTI-NODE SETUP section will allow you to use one 
  308.       batch file and one config file to run this door on all nodes.
  309.  
  310.  
  311.  
  312.  
  313.                            MULTI-NODE SETUP
  314.                            ________________
  315.  
  316.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  317.       ability to access a configuration file which will have its own system 
  318.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  319.       line. There are 2 ways to accomplish this:
  320.  
  321.       (1) Create a separate configuration file for each node. The only 
  322.           difference between each file would be the location of the system 
  323.           file for that particular node. For example, on my system there are 2
  324.           nodes and the first line of the config files would look like this:
  325.  
  326.                         NODE1:  H:\PCB1\DOOR.SYS
  327.                         NODE2:  H:\PCB2\DOOR.SYS
  328.  
  329.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  330.  
  331.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  332.           the following PCBoard environmental variables:
  333.  
  334.                  PCBDIR    (Directory containing the System file)
  335.                  PCBDRIVE  (Drive containing the System file)
  336.  
  337.           Thus, the first line of the SINGLE configuration file, for this Door
  338.           would look like this:
  339.  
  340.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  341.  
  342.       NOTE: This option, as described, assumes that you are running PCBoard 
  343.             14.5a software. The environmental variables are automatically 
  344.             created by the software for each node.
  345.  
  346.             HOWEVER, if you are running other BBS software you should be able
  347.             to set the variables EXACTLY as described below, for EACH node 
  348.             (more than likely in each batch file you use to bring up EACH node):
  349.  
  350.                             PCBDRIVE=C:
  351.                             ^^^^^^^^^
  352.                             PCBDIR=\NODE2
  353.                             ^^^^^^^^
  354.             
  355.             Info with a carat (^) under it, MUST be typed as is. The rest 
  356.             depends on your naming conventions. 
  357.  
  358.             This, in combination with the use of the optional environmental
  359.             variable described in the NON-STANDARD COM SUPPORT section, will
  360.             allow you to use one batch file and one config file to run this 
  361.             door on all nodes.
  362.  
  363.  
  364.  
  365.                                ADOPT-A-DOOR
  366.                                ____________
  367.  
  368.     Having been a Sysop for a number of years, I have had my share of problems
  369.     and frustrations getting financial support for my board's upkeep. A fellow
  370.     Sysop left a message on my board, not long ago, about a concept that was
  371.     being used by several boards around the country.
  372.  
  373.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  374.     would be the same as sending in a donation, only this way it is earmarked
  375.     for registering a particular door. In a way, the user feels he/she is
  376.     "getting something in return". As a Door author I have decided to build
  377.     this concept into each of my Door programs. The concept replaces the
  378.     usual message "tell the Sysop to register this Door" we find in most
  379.     doors.
  380.  
  381.     If the Door is unregisterd then a message appears on the opening screen
  382.     to that effect. After finishing or suspending a game, a message screen
  383.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  384.     caller to contact the Sysop to find out if there is any further details
  385.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  386.     time, etc to callers that ADOPT-A-DOOR.
  387.  
  388.     If the Door has been registered, either by the Sysop or other callers,
  389.     the names of those contributors will be displayed in the closing screen.
  390.  
  391.     NOTE: If you want to display the names of the callers that contributed
  392.           to registering the Door, you must create an ASCII file called
  393.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  394.           the name(s) of the contributors (one on each line, maximum of 5
  395.           entries, each a maximum of 30 characters long). This file must be
  396.           saved, in ASCII format, and placed in the Door directory.
  397.  
  398.  
  399.  
  400.                               LEGALITIES
  401.                               __________
  402.  
  403.  
  404.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  405.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  406.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  407.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  408.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  409.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  410.       OR BREACH OF ANY WARRANTY.
  411.  
  412.  
  413.  
  414.  
  415.  
  416.                              DISTRIBUTION
  417.                              ____________
  418.  
  419.    You may make this file available for downloading from your BBS or you may
  420.    upload it to any BBS of your choice, provided that you do not make any
  421.    changes to the contents of the archive (ZIP file). The archive and its
  422.    individual contents may not be used by any service that charges any money
  423.    whatsoever, without the written permission of the author.
  424.  
  425.  
  426.  
  427.  
  428.  
  429.                              REGISTRATION
  430.                              ____________
  431.  
  432.    Registration and the subsequent insertion of the registration number into
  433.    your configuation file, allows for the display of your BBS name on the
  434.    opening and closing screen as well as the reduction of a delay built into
  435.    the opening screen display along with the ability to change certain
  436.    values in the configuration file.
  437.  
  438.    To register your copy of BETSY, please fill out the registration form
  439.    (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  440.    the name and address on the form.
  441.  
  442.    Be sure to use the proper upper/lower case when filling in your name and
  443.    BBS name, as they MUST match the way you entered them in the configuration
  444.    file.             ^^^^
  445.  
  446.    Based upon information supplied on the registration form, I will pre-
  447.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  448.    up your registration number.
  449.  
  450.  
  451.  
  452.                                  MISC
  453.                                  ____
  454.  
  455.    The latest version of BETSY ROSS and other fine SUNRISE DOOR programs
  456.    are always available for download from SUNRISE-80 BBS.
  457.  
  458.    Remember, should you have any problems, questions or suggestions, be sure
  459.    to drop me a message on Sunrise-80 or in the RIME network (BBS_Doors, 
  460.    PCBHints, SYSops) or on SMARTNET (SN_Sysops) or FIDO 1:133/410.
  461.